home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / bestutil.zip / NDOSEDIT.DOC < prev    next >
Text File  |  1984-06-08  |  6KB  |  142 lines
  1.                DOSEDIT User's Guide
  2.  
  3.                Jack Gersbach
  4.               Burlington, Vt.
  5.  
  6.  
  7. Abstract:
  8.  
  9. DOSEDIT is a VM style editor for dos commands lifted out of DOS 1.86.
  10. It can be used with DOS 1.1 and 2.0.
  11.  
  12.  
  13. Corrections and Enhancements
  14.  
  15. Suggestions for additions or changes are welcome.
  16.  
  17.  
  18. Installation
  19.  
  20. Download and copy DOSEDIT.COM onto a diskette.
  21. Type dosedit at the dos prompt and it will install itself as a
  22. resident extension to dos. If you wish to set up an aliase list,
  23. type:
  24.     DOSEDIT filespec
  25.  
  26. The file contains a list of aliases and replacement phrases
  27. as described below.
  28.  
  29.  
  30. Operational Description
  31. Special DOS EDITING KEYS
  32.  
  33. The DOS editing keys are different than the standard dos keys and are
  34. more natural for the average user. The function keys on the left side
  35. of the keyboard are not used.
  36.  
  37. The information below summarizes the functions of the new editing keys.
  38.  
  39. Right arrow:    Advances the cursor one character position.
  40. Left arrow:    Backs up the cursor one character position.
  41. Ctrl-Right:    Advances the cursor to the next word.
  42. Ctrl-Left:    Backs up the cursor to the previous word.
  43. LeftShift-tab:    Backs up the cursor to the previous tab position.
  44. RightShift-tab: Advances the cursor to the next tab position.
  45. Home:        Moves the cursor to the beginning of the line.
  46. End:        Moves the cursor to the end of the line.
  47. Del:        Erases the character at the cursor position.
  48. Back Space:    Erases the character to left of the cursor.
  49. Esc:        Erases the entire line.
  50. Ctrl-Home:    Erases from the beginning of the line to the cursor.
  51. Ctrl-end:    Erases from the cursor to the end of the line.
  52. Up arrow:    Recalls the previous instruction from the stack.
  53. Down arrow:    Recalls the following instruction from the stack.
  54. Ctrl-PgUp:    Clears the current stack of all entries.
  55. Ctrl-PgDn:    Erases the currently displayed stack entry.
  56. Ins:        Toggles the insert mode. If active, cursor size changes.
  57. Ctrl-A:     Displays aliase list when under dos control.
  58. Ctrl-Z:     End of file marker (1AH). Replaces the F6 key.
  59. F1 thru F10:    Not used.
  60.  
  61. The insert mode is automatically turned off with Enter or Esc.
  62.  
  63. Two circular stacks of 256 bytes each stores all new or edited commands
  64. that are entered from the keyboard.
  65.  
  66. One stack serves the dos command mode and the other serves calls from
  67. external commands and application programs.
  68. These programs must use
  69. Dos function call 0AH to access dosedit and the command stack.
  70.  
  71. Dosedit traps the command.com buffer segment and dedicates one stack
  72. to it and the other for all other buffers.
  73. It is recommended that DOSEDIT be loaded lower (earlier) than any
  74. other resident dos extension that calls the dos editor
  75. (function call 0AH).
  76.  
  77. After executing a command, the stack pointer is set between the current
  78. command and the next one.
  79. The previous command can then be recalled by pressing the up arrow.
  80. If the current command is new, it is placed at the end of the stack
  81. and the stack pointer points between the last command and the first
  82. one entered.
  83. The 1st command will be lost if the stack has filled up and wrapped
  84. around to the beginning.
  85.  
  86. The currently displayed command line is executed when enter is pressed.
  87. The cursor may be at any position in the line when enter or the up/down
  88. arrow keys are pressed.
  89.  
  90. If the calling program passes a line of text in it's buffer, it can be
  91. displayed and edited by pressing the End key. DOS will reshow the
  92. buffer contents if there is a carriage return character at the end
  93. of the text as indicated by the 2nd byte of the buffer.
  94.  
  95. The interface description for function call 0AH applies in all respects.
  96.  
  97. Aliases
  98.  
  99. Aliases may be defined in a separate file that DOSEDIT will read when
  100. it is installed.
  101. Refer to "installing dosedit", above.
  102.  
  103. The form of the file is:
  104.  
  105. Alias1 replacement phrase
  106. Alias2 replacement phrase
  107.    .
  108.    .
  109.    .
  110. AliasN replacement phrase
  111. EOF
  112.  
  113.  
  114. Each line must end with a carriage return - line feed combination.
  115. The file must end with an EOF mark of 1AH.
  116.  
  117. If the aliase file is unacceptable to dosedit, an error message is
  118. displayed and dosedit will not be installed.
  119.  
  120. Aliases may be displayed by pressing the "A" key while holding down
  121. the Ctrl key.
  122.  
  123. This is the standard text file format produced by text editors such
  124. as Edlin, The Personal Editor, etc.
  125.  
  126. Aliases must be limited to 8 characters and may include any character
  127. that is legal in a file name.
  128.  
  129. The replacement phrase may be any length but could cause overflow of
  130. command's text buffer at the time of substitution. If this happens,
  131. a message is displayed and a nul string is returned by dosedit.
  132. Aliases are only active while in the dos command mode. The replacement
  133. string is never displayed but is returned to command.com in the command
  134. text buffer.
  135.  
  136. When an alias is used on a command line, it must be the first word of
  137. the line although a drive specifier may preceed it. For example,
  138. if fmt is an alias for format, C:fmt will cause dos to assume that
  139. format.com will be found on drive C.
  140.  assume that
  141. format.com will be found on drive C.
  142.